Class Config

Summary

Fully Qualified Name: CodeIgniter\Database\Config
Extends: BaseConfig

Description

Class Config

Methods

Name Description Defined By
__construct() Will attempt to get environment variables with names that match the properties of the child class. BaseConfig
connect() Creates the default Config
forge() Loads and returns an instance of the Forge for the specified database group, and loads the group if it hasn't been loaded yet. Config
getConnections() Returns an array of all db connections currently made. Config
seeder() Returns a new instance of the Database Seeder. Config
utils() Returns a new instance of the Database Utilities class. Config

Method Details

__construct()

Will attempt to get environment variables with names that match the properties of the child class.

The "shortPrefix" is the lowercase-only config class name.

Returns:

connect()

Creates the default

Parameter Name Type Description
$group string|array The
$getShared bool Whether

Returns: \BaseConnection

forge()

Loads and returns an instance of the Forge for the specified database group, and loads the group if it hasn't been loaded yet.

Parameter Name Type Description
$group string|array|null

Returns: \Forge

getConnections()

Returns an array of all db connections currently made.

Returns: array

seeder()

Returns a new instance of the Database Seeder.

Parameter Name Type Description
$group string|null

Returns: \Seeder

utils()

Returns a new instance of the Database Utilities class.

Parameter Name Type Description
$group string|array|null

Returns: \BaseUtils

Top